Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Add put snapshot repo API docs #56827

Merged
merged 3 commits into from
May 18, 2020
Merged

[DOCS] Add put snapshot repo API docs #56827

merged 3 commits into from
May 18, 2020

Conversation

jrodewig
Copy link
Contributor

Relates to #56069

@jrodewig jrodewig added >docs General docs changes >non-issue :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v8.0.0 v7.7.1 v7.8.1 v7.9.0 labels May 15, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Snapshot/Restore)

@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label May 15, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label May 15, 2020
original-brownbear
original-brownbear approved these changes May 15, 2020
View reviewed changes
Copy link
Member

@original-brownbear original-brownbear left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks! Suggested one possible addition (the multiple clusters write at the same time bit) and a change we can make later that I just wanted to raise to a wider audience (removing compress documentation).

docs/reference/snapshot-restore/apis/put-repo-api.asciidoc
broken down into chunks of this size or smaller. Defaults to `null` (unlimited
file size).

`compress`::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just leave this out of the documentation maybe? This is a really useless setting at this point. Having it documented has led to some confusion in the past and I can't see what a user would get out of setting this to false.
@DaveCTurner @tlrx any thoughts on this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll wait for more feedback, but if we remove this, I'll also remove the reference here:
https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-register-repository.html#snapshots-filesystem-repository

docs/reference/snapshot-restore/apis/put-repo-api.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

Thanks @original-brownbear. I'll go ahead and merge this. If we decide to go that direction, I'll remove the compress param docs as part of a later effort.

@jrodewig jrodewig merged commit 76e45d9 into elastic:master May 18, 2020
@jrodewig jrodewig deleted the docs__create-repo-api-docs branch May 18, 2020 12:42
This was referenced May 18, 2020
Merged
Merged
Merged
jrodewig added a commit that referenced this pull request May 18, 2020
@jrodewig
[DOCS] Add put snapshot repo API docs (#56827) (#56900)
74554f1
jrodewig added a commit that referenced this pull request May 18, 2020
@jrodewig
[DOCS] Add put snapshot repo API docs (#56827) (#56901)
6d9c2c2
jrodewig added a commit that referenced this pull request May 18, 2020
@jrodewig
[DOCS] Add put snapshot repo API docs (#56827) (#56902)
80bcd0a
@jrodewig
Copy link
Contributor Author

Backport commits

master 76e45d9
7.x 74554f1
7.8 6d9c2c2
7.7 80bcd0a

@DaveCTurner DaveCTurner mentioned this pull request May 20, 2020
Closed
10 tasks
@jrodewig jrodewig mentioned this pull request Jan 24, 2022
Merged
jrodewig added a commit that referenced this pull request Jan 24, 2022
@jrodewig
[DOCS] Remove compress param from example snippets (#82994)
8ac973f 
Per [this comment](#56827 (comment)) in #56827, we don't need to highlight the `compress` parameter. The parameter defaults to `true` anyway.
elasticsearchmachine pushed a commit that referenced this pull request Jan 24, 2022
@jrodewig
[DOCS] Remove compress param from example snippets (#82994) (#83000)
a1b936b 
Per [this comment](#56827 (comment)) in #56827, we don't need to highlight the `compress` parameter. The parameter defaults to `true` anyway.

(cherry picked from commit 8ac973f)
jrodewig added a commit that referenced this pull request Jan 24, 2022
@jrodewig
[DOCS] Remove compress param from example snippets (#82994) (#82998)
b91ed91 
Per [this comment](#56827 (comment)) in #56827, we don't need to highlight the `compress` parameter. The parameter defaults to `true` anyway.

(cherry picked from commit 8ac973f)
jrodewig added a commit that referenced this pull request Jan 24, 2022
@jrodewig
[DOCS] Remove compress param from example snippets (#82994) (#82999)
42a4d5d 
Per [this comment](#56827 (comment)) in #56827, we don't need to highlight the `compress` parameter. The parameter defaults to `true` anyway.

(cherry picked from commit 8ac973f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@original-brownbear original-brownbear original-brownbear approved these changes

Assignees
No one assigned
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes >non-issue Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.7.1 v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jrodewig @elasticmachine @original-brownbear @jakelandis